Describesummary

Description

Obtain the risk item information detected by the baseline check according to the risk classification.

Request Method

POST

Request Path

/apsara/route/aegis/Describesummary

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
TypeNames	BODY	string	No	No sample value for this parameter.	risk category name, separated by "," when specifying multiple risk categories.
PageSize	BODY	integer	No	No sample value for this parameter.	specifies the maximum number of records per page in the returned result. Default value: 20
SubTypeNames	BODY	string	No	No sample value for this parameter.	sub-risk category names, separated by "," when specifying multiple sub-risk categories.
StatusList	BODY	string	No	No sample value for this parameter.	Risk item processing status, value range: 1: indicates pending processing 2: indicates that it has been ignored 3: indicates confirmed 8: indicates that it has been marked as a false positive 16: indicates that processing 32: indicates that the processing is complete supports specifying multiple states separated.
StrategyId	BODY	long	No	No sample value for this parameter.	baseline check policy ID.
Dealed	BODY	string	No	No sample value for this parameter.	whether the risk item has been processed. Y: indicates processed N: indicates unprocessed
version	BODY	string	No	2016-01-01	version of api
RiskLevels	BODY	string	No	No sample value for this parameter.	risk levels, separated by "," when multiple risk levels are specified.
RiskName	BODY	string	No	No sample value for this parameter.	risk item name. description supports fuzzy matching search.
CurrentPage	BODY	integer	No	No sample value for this parameter.	specifies the number of pages currently returned. default value: 1
regionId	BODY	string	Yes	No sample value for this parameter.	region id
Uuids	BODY	string	No	No sample value for this parameter.	host asset UUID, specifying multiple host asset UUIDs separated.

Return data

Name	Type	Sample value	Description
PendingCount	integer	no demo value	number of risk items to be processed.
RiskId	long	no demo value	risk item ID.
RequestId	string	no demo value	request ID.
PageSize	integer	no demo value	page displays the maximum number of records.
RiskDetail	string	no demo value	details of risk items.
TypeAlias	string	no demo value	risk category name.
Count	integer	no demo value	Number of risk item records returned.
RiskName	string	no demo value	risk item name.
SubTypeAlias	string	no demo value	sub-risk category name.
LastFoundTime	string	no demo value	Last discovery time.
TotalCount	integer	no demo value	total number of risk items.
CurrentPage	integer	no demo value	currently returns page number.
Level	string	no demo value	risk level.
WarningSummarys	array	no demo value	list of risk items. see the following parameter description for specific sub-items.

Example

Successful Response example

{
 "PendingCount":"no demo value",
 "RiskId":"no demo value",
 "RequestId":"no demo value",
 "PageSize":"no demo value",
 "RiskDetail":"no demo value",
 "TypeAlias":"no demo value",
 "Count":"no demo value",
 "RiskName":"no demo value",
 "SubTypeAlias":"no demo value",
 "LastFoundTime":"no demo value",
 "TotalCount":"no demo value",
 "CurrentPage":"no demo value",
 "Level":"no demo value",
 "WarningSummarys":"no demo value"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}